<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ISearchFactory</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface ISearchFactory</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ISearchFactory is a factory used to create the <a href="../sde_fastsearch_view/ISearchView.html">ISearchView</a> instances.</p>
<p class="description"><p>To instantiate the factory interface, use <a href="../sde_fastsearch/SearchFactory.html">SearchFactory</a>.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: ISearchFactory.html 20 2010-01-28 14:33:07Z kenn.north $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---ISearchFactory.php.html">/src/sde/fastsearch/ISearchFactory.php</a> (line <span class="field">31</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_view/ISearchView.html">ISearchView</a></span>
										<a href="#getSearchView" title="details" class="method-name">getSearchView</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'default'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$reload</span> = <span class="var-default">false</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getSearchViewList" title="details" class="method-name">getSearchViewList</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setProperties" title="details" class="method-name">setProperties</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$properties</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setSearchViewList" title="details" class="method-name">setSearchViewList</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$viewList</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetSearchView" id="getSearchView"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSearchView</span> (line <span class="line-number">42</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the search view with the specified name, with the option of  forcing a reload of the view from the qrserver.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> <a href="../sde_fastsearch/SearchEngineException.html">SearchEngineException</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_view/ISearchView.html">ISearchView</a></span>
		<span class="method-name">
			getSearchView
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">'default'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$reload</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$reload</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSearchViewList" id="getSearchViewList"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSearchViewList</span> (line <span class="line-number">50</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the names of all existing search views in FAST ESP.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> <a href="../sde_fastsearch/SearchEngineException.html">SearchEngineException</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getSearchViewList
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetProperties" id="setProperties"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setProperties</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the properties for the used search engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setProperties
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$properties</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$properties</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetSearchViewList" id="setSearchViewList"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setSearchViewList</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the names of all existing search views in FAST ESP to suppress request</p>
<p class="description"><p>for retrieving these search view names. Be careful: Setting invalid views  here will result in invalid search requests. Best practice is to cache the  availabe search view list after the first search request and set it for  further search requests using this method.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setSearchViewList
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$viewList</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$viewList</span><span class="var-description">: List of available search views.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:36:05 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>